<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkAccelLabel: GTK+ 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
<link rel="up" href="DisplayWidgets.html" title="Display Widgets">
<link rel="prev" href="GtkStatusbar.html" title="GtkStatusbar">
<link rel="next" href="ButtonWidgets.html" title="Buttons and Toggles">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GtkAccelLabel.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GtkAccelLabel.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GtkAccelLabel.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GtkAccelLabel.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="DisplayWidgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkStatusbar.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ButtonWidgets.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkAccelLabel"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkAccelLabel.top_of_page"></a>GtkAccelLabel</span></h2>
<p>GtkAccelLabel — A label which displays an accelerator key on the right of the text</p>
</td>
<td class="gallery_image" valign="top" align="right"><img src="accel-label.png"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkAccelLabel.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkAccelLabel.html#gtk-accel-label-new" title="gtk_accel_label_new ()">gtk_accel_label_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkAccelLabel.html#gtk-accel-label-set-accel-closure" title="gtk_accel_label_set_accel_closure ()">gtk_accel_label_set_accel_closure</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkAccelLabel.html#gtk-accel-label-get-accel-widget" title="gtk_accel_label_get_accel_widget ()">gtk_accel_label_get_accel_widget</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkAccelLabel.html#gtk-accel-label-set-accel-widget" title="gtk_accel_label_set_accel_widget ()">gtk_accel_label_set_accel_widget</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="GtkAccelLabel.html#gtk-accel-label-get-accel-width" title="gtk_accel_label_get_accel_width ()">gtk_accel_label_get_accel_width</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkAccelLabel.html#gtk-accel-label-set-accel" title="gtk_accel_label_set_accel ()">gtk_accel_label_set_accel</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkAccelLabel.html#gtk-accel-label-get-accel" title="gtk_accel_label_get_accel ()">gtk_accel_label_get_accel</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GtkAccelLabel.html#gtk-accel-label-refetch" title="gtk_accel_label_refetch ()">gtk_accel_label_refetch</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkAccelLabel.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">GClosure</span> *</td>
<td class="property_name"><a class="link" href="GtkAccelLabel.html#GtkAccelLabel--accel-closure" title="The “accel-closure” property">accel-closure</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *</td>
<td class="property_name"><a class="link" href="GtkAccelLabel.html#GtkAccelLabel--accel-widget" title="The “accel-widget” property">accel-widget</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkAccelLabel.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkAccelLabel.html#GtkAccelLabel-struct" title="struct GtkAccelLabel">GtkAccelLabel</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkAccelLabel.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GInitiallyUnowned
        <span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
            <span class="lineart">╰──</span> <a class="link" href="GtkMisc.html" title="GtkMisc">GtkMisc</a>
                <span class="lineart">╰──</span> <a class="link" href="GtkLabel.html" title="GtkLabel">GtkLabel</a>
                    <span class="lineart">╰──</span> GtkAccelLabel
</pre>
</div>
<div class="refsect1">
<a name="GtkAccelLabel.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkAccelLabel implements
 AtkImplementorIface and  <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkAccelLabel.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gtk/gtk.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GtkAccelLabel.description"></a><h2>Description</h2>
<p>The <a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> widget is a subclass of <a class="link" href="GtkLabel.html" title="GtkLabel"><span class="type">GtkLabel</span></a> that also displays an
accelerator key on the right of the label text, e.g. “Ctrl+S”.
It is commonly used in menus to show the keyboard short-cuts for commands.</p>
<p>The accelerator key to display is typically not set explicitly (although it
can be, with <a class="link" href="GtkAccelLabel.html#gtk-accel-label-set-accel" title="gtk_accel_label_set_accel ()"><code class="function">gtk_accel_label_set_accel()</code></a>). Instead, the <a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> displays
the accelerators which have been added to a particular widget. This widget is
set by calling <a class="link" href="GtkAccelLabel.html#gtk-accel-label-set-accel-widget" title="gtk_accel_label_set_accel_widget ()"><code class="function">gtk_accel_label_set_accel_widget()</code></a>.</p>
<p>For example, a <a class="link" href="GtkMenuItem.html" title="GtkMenuItem"><span class="type">GtkMenuItem</span></a> widget may have an accelerator added to emit
the “activate” signal when the “Ctrl+S” key combination is pressed.
A <a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> is created and added to the <a class="link" href="GtkMenuItem.html" title="GtkMenuItem"><span class="type">GtkMenuItem</span></a>, and
<a class="link" href="GtkAccelLabel.html#gtk-accel-label-set-accel-widget" title="gtk_accel_label_set_accel_widget ()"><code class="function">gtk_accel_label_set_accel_widget()</code></a> is called with the <a class="link" href="GtkMenuItem.html" title="GtkMenuItem"><span class="type">GtkMenuItem</span></a> as the
second argument. The <a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> will now display “Ctrl+S” after its label.</p>
<p>Note that creating a <a class="link" href="GtkMenuItem.html" title="GtkMenuItem"><span class="type">GtkMenuItem</span></a> with <a class="link" href="GtkMenuItem.html#gtk-menu-item-new-with-label" title="gtk_menu_item_new_with_label ()"><code class="function">gtk_menu_item_new_with_label()</code></a> (or
one of the similar functions for <a class="link" href="GtkCheckMenuItem.html" title="GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> and <a class="link" href="GtkRadioMenuItem.html" title="GtkRadioMenuItem"><span class="type">GtkRadioMenuItem</span></a>)
automatically adds a <a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> to the <a class="link" href="GtkMenuItem.html" title="GtkMenuItem"><span class="type">GtkMenuItem</span></a> and calls
<a class="link" href="GtkAccelLabel.html#gtk-accel-label-set-accel-widget" title="gtk_accel_label_set_accel_widget ()"><code class="function">gtk_accel_label_set_accel_widget()</code></a> to set it up for you.</p>
<p>A <a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> will only display accelerators which have <a class="link" href="gtk3-Keyboard-Accelerators.html#GTK-ACCEL-VISIBLE:CAPS"><code class="literal">GTK_ACCEL_VISIBLE</code></a>
set (see <a class="link" href="gtk3-Keyboard-Accelerators.html#GtkAccelFlags" title="enum GtkAccelFlags"><span class="type">GtkAccelFlags</span></a>).
A <a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> can display multiple accelerators and even signal names,
though it is almost always used to display just one accelerator key.</p>
<div class="refsect3">
<a name="id-1.3.8.9.9.7"></a><h4>Creating a simple menu item with an accelerator key.</h4>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="n">GtkWidget</span> <span class="o">*</span><span class="n">window</span> <span class="o">=</span> <span class="n">gtk_window_new</span> <span class="p">(</span><span class="n">GTK_WINDOW_TOPLEVEL</span><span class="p">);</span>
<span class="n">GtkWidget</span> <span class="o">*</span><span class="n">menu</span> <span class="o">=</span> <span class="n">gtk_menu_new</span> <span class="p">();</span>
<span class="n">GtkWidget</span> <span class="o">*</span><span class="n">save_item</span><span class="p">;</span>
<span class="n">GtkAccelGroup</span> <span class="o">*</span><span class="n">accel_group</span><span class="p">;</span>

<span class="c1">// Create a GtkAccelGroup and add it to the window.</span>
<span class="n">accel_group</span> <span class="o">=</span> <span class="n">gtk_accel_group_new</span> <span class="p">();</span>
<span class="n">gtk_window_add_accel_group</span> <span class="p">(</span><span class="n">GTK_WINDOW</span> <span class="p">(</span><span class="n">window</span><span class="p">),</span> <span class="n">accel_group</span><span class="p">);</span>

<span class="c1">// Create the menu item using the convenience function.</span>
<span class="n">save_item</span> <span class="o">=</span> <span class="n">gtk_menu_item_new_with_label</span> <span class="p">(</span><span class="s">&quot;Save&quot;</span><span class="p">);</span>
<span class="n">gtk_widget_show</span> <span class="p">(</span><span class="n">save_item</span><span class="p">);</span>
<span class="n">gtk_container_add</span> <span class="p">(</span><span class="n">GTK_CONTAINER</span> <span class="p">(</span><span class="n">menu</span><span class="p">),</span> <span class="n">save_item</span><span class="p">);</span>

<span class="c1">// Now add the accelerator to the GtkMenuItem. Note that since we</span>
<span class="c1">// called gtk_menu_item_new_with_label() to create the GtkMenuItem</span>
<span class="c1">// the GtkAccelLabel is automatically set up to display the</span>
<span class="c1">// GtkMenuItem accelerators. We just need to make sure we use</span>
<span class="c1">// GTK_ACCEL_VISIBLE here.</span>
<span class="n">gtk_widget_add_accelerator</span> <span class="p">(</span><span class="n">save_item</span><span class="p">,</span> <span class="s">&quot;activate&quot;</span><span class="p">,</span> <span class="n">accel_group</span><span class="p">,</span>
                            <span class="n">GDK_KEY_s</span><span class="p">,</span> <span class="n">GDK_CONTROL_MASK</span><span class="p">,</span> <span class="n">GTK_ACCEL_VISIBLE</span><span class="p">);</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
</div>
<div class="refsect2">
<a name="id-1.3.8.9.9.8"></a><h3>CSS nodes</h3>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="n">label</span>
<span class="err">╰──</span> <span class="n">accelerator</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
<p>Like <a class="link" href="GtkLabel.html" title="GtkLabel"><span class="type">GtkLabel</span></a>, GtkAccelLabel has a main CSS node with the name label.
It adds a subnode with name accelerator.</p>
</div>
</div>
<div class="refsect1">
<a name="GtkAccelLabel.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-accel-label-new"></a><h3>gtk_accel_label_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
gtk_accel_label_new (<em class="parameter"><code>const <span class="type">gchar</span> *string</code></em>);</pre>
<p>Creates a new <a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a>.</p>
<div class="refsect3">
<a name="gtk-accel-label-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>string</p></td>
<td class="parameter_description"><p>the label string. Must be non-<code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-accel-label-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-accel-label-set-accel-closure"></a><h3>gtk_accel_label_set_accel_closure ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_accel_label_set_accel_closure (<em class="parameter"><code><a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> *accel_label</code></em>,
                                   <em class="parameter"><code><span class="type">GClosure</span> *accel_closure</code></em>);</pre>
<p>Sets the closure to be monitored by this accelerator label. The closure
must be connected to an accelerator group; see <a class="link" href="gtk3-Keyboard-Accelerators.html#gtk-accel-group-connect" title="gtk_accel_group_connect ()"><code class="function">gtk_accel_group_connect()</code></a>.
Passing <code class="literal">NULL</code> for <em class="parameter"><code>accel_closure</code></em>
 will dissociate <em class="parameter"><code>accel_label</code></em>
 from its
current closure, if any.</p>
<div class="refsect3">
<a name="gtk-accel-label-set-accel-closure.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>accel_label</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>accel_closure</p></td>
<td class="parameter_description"><p>the closure to monitor for accelerator changes,
or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-accel-label-get-accel-widget"></a><h3>gtk_accel_label_get_accel_widget ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
gtk_accel_label_get_accel_widget (<em class="parameter"><code><a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> *accel_label</code></em>);</pre>
<p>Fetches the widget monitored by this accelerator label. See
<a class="link" href="GtkAccelLabel.html#gtk-accel-label-set-accel-widget" title="gtk_accel_label_set_accel_widget ()"><code class="function">gtk_accel_label_set_accel_widget()</code></a>.</p>
<div class="refsect3">
<a name="gtk-accel-label-get-accel-widget.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>accel_label</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-accel-label-get-accel-widget.returns"></a><h4>Returns</h4>
<p>the object monitored by the accelerator label, or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-accel-label-set-accel-widget"></a><h3>gtk_accel_label_set_accel_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_accel_label_set_accel_widget (<em class="parameter"><code><a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> *accel_label</code></em>,
                                  <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *accel_widget</code></em>);</pre>
<p>Sets the widget to be monitored by this accelerator label. Passing <code class="literal">NULL</code> for
<em class="parameter"><code>accel_widget</code></em>
 will dissociate <em class="parameter"><code>accel_label</code></em>
 from its current widget, if any.</p>
<div class="refsect3">
<a name="gtk-accel-label-set-accel-widget.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>accel_label</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>accel_widget</p></td>
<td class="parameter_description"><p>the widget to be monitored, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-accel-label-get-accel-width"></a><h3>gtk_accel_label_get_accel_width ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
gtk_accel_label_get_accel_width (<em class="parameter"><code><a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> *accel_label</code></em>);</pre>
<p>Returns the width needed to display the accelerator key(s).
This is used by menus to align all of the <a class="link" href="GtkMenuItem.html" title="GtkMenuItem"><span class="type">GtkMenuItem</span></a> widgets, and shouldn't
be needed by applications.</p>
<div class="refsect3">
<a name="gtk-accel-label-get-accel-width.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>accel_label</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-accel-label-get-accel-width.returns"></a><h4>Returns</h4>
<p> the width needed to display the accelerator key(s).</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-accel-label-set-accel"></a><h3>gtk_accel_label_set_accel ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_accel_label_set_accel (<em class="parameter"><code><a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> *accel_label</code></em>,
                           <em class="parameter"><code><span class="type">guint</span> accelerator_key</code></em>,
                           <em class="parameter"><code><span class="type">GdkModifierType</span> accelerator_mods</code></em>);</pre>
<p>Manually sets a keyval and modifier mask as the accelerator rendered
by <em class="parameter"><code>accel_label</code></em>
.</p>
<p>If a keyval and modifier are explicitly set then these values are
used regardless of any associated accel closure or widget.</p>
<p>Providing an <em class="parameter"><code>accelerator_key</code></em>
 of 0 removes the manual setting.</p>
<div class="refsect3">
<a name="gtk-accel-label-set-accel.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>accel_label</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>accelerator_key</p></td>
<td class="parameter_description"><p>a keyval, or 0</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>accelerator_mods</p></td>
<td class="parameter_description"><p>the modifier mask for the accel</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-accel-label-get-accel"></a><h3>gtk_accel_label_get_accel ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_accel_label_get_accel (<em class="parameter"><code><a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> *accel_label</code></em>,
                           <em class="parameter"><code><span class="type">guint</span> *accelerator_key</code></em>,
                           <em class="parameter"><code><span class="type">GdkModifierType</span> *accelerator_mods</code></em>);</pre>
<p>Gets the keyval and modifier mask set with
<a class="link" href="GtkAccelLabel.html#gtk-accel-label-set-accel" title="gtk_accel_label_set_accel ()"><code class="function">gtk_accel_label_set_accel()</code></a>.</p>
<div class="refsect3">
<a name="gtk-accel-label-get-accel.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>accel_label</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>accelerator_key</p></td>
<td class="parameter_description"><p>return location for the keyval. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>accelerator_mods</p></td>
<td class="parameter_description"><p>return location for the modifier mask. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-12.html#api-index-3.12">3.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-accel-label-refetch"></a><h3>gtk_accel_label_refetch ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_accel_label_refetch (<em class="parameter"><code><a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> *accel_label</code></em>);</pre>
<p>Recreates the string representing the accelerator keys.
This should not be needed since the string is automatically updated whenever
accelerators are added or removed from the associated widget.</p>
<div class="refsect3">
<a name="gtk-accel-label-refetch.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>accel_label</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkAccelLabel.html" title="GtkAccelLabel"><span class="type">GtkAccelLabel</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-accel-label-refetch.returns"></a><h4>Returns</h4>
<p> always returns <code class="literal">FALSE</code>.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GtkAccelLabel.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkAccelLabel-struct"></a><h3>struct GtkAccelLabel</h3>
<pre class="programlisting">struct GtkAccelLabel;</pre>
<p>The <a class="link" href="GtkAccelLabel.html#GtkAccelLabel-struct" title="struct GtkAccelLabel"><span class="type">GtkAccelLabel</span></a> contains private data only, and
should be accessed using the functions below.</p>
</div>
</div>
<div class="refsect1">
<a name="GtkAccelLabel.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkAccelLabel--accel-closure"></a><h3>The <code class="literal">“accel-closure”</code> property</h3>
<pre class="programlisting">  “accel-closure”            <span class="type">GClosure</span> *</pre>
<p>The closure to be monitored for accelerator changes.</p>
<p>Owner: GtkAccelLabel</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkAccelLabel--accel-widget"></a><h3>The <code class="literal">“accel-widget”</code> property</h3>
<pre class="programlisting">  “accel-widget”             <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *</pre>
<p>The widget to be monitored for accelerator changes.</p>
<p>Owner: GtkAccelLabel</p>
<p>Flags: Read / Write</p>
</div>
</div>
<div class="refsect1">
<a name="GtkAccelLabel.see-also"></a><h2>See Also</h2>
<p><a class="link" href="gtk3-Keyboard-Accelerators.html#GtkAccelGroup"><span class="type">GtkAccelGroup</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>